Skip to main content

SFTP Session

AutomatR.SFTP.SFTPSession

The "SFTP Session" activity in AutomatR is part of the SFTP activities package, facilitating the establishment of a connection to an SFTP server for performing various SFTP activities. This activity serves as the initial step for interacting with an SFTP server in an automation workflow.

Properties​

NameDescription
Input
HostSpecifies the address of the SFTP server to which you wish to connect. String variables containing the server address.
PasswordSpecifies the password to use when connecting to the SFTP server. String variables containing the password.
PortSpecifies the port number of the SFTP server to which you want to connect. Integer variables containing the port number.
User NameSpecifies the username to use when connecting to the SFTP server. String variables containing the username.
Misc
Display NameProvides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name.
Optional
DelaySpecifies the amount of time (in seconds) to wait before starting the activity. Useful for handling synchronization issues.
Output
ResultProvides a connected SftpClient object that can be used for additional SFTP activities. Variables of type SftpClient to store the connected client object.

How to use:​

  1. Drag and drop the "SFTP Session" activity onto the workflow.
  2. Configure the properties by specifying the SFTP server details, including host, port, username, and password.
  3. Optionally, configure the delay and customize the display name.
  4. Execute the workflow to establish a connection to the SFTP server.
  5. The connected SftpClient object is available as an output, which can be used in subsequent SFTP activities.

Example:​

Consider an example where the "SFTP Session" activity is used to establish a connection to an SFTP server:

SFTP Session:
  Display Name: "Connect to SFTP Server"
  Host: "sftp.example.com"
  Port: 22
  User Name: "username"
  Password: "password"
  Result: sftpClientObject

In this example, the activity establishes a connection to the SFTP server with the specified details. The connected SftpClient object (sftpClientObject) can be used in subsequent SFTP activities within the workflow.